/*
 * Copyright 2009 Max Kugland
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.splink.deepsplink.authentication {
	import org.splink.library.distributor.IDistributor;

	/**
	 * The <code>IAuthenticator</code> interface defines basic functionality
	 * for classes which a meant to provide authentication (i.e. login/logout) mechanisms.
	 * 
	 * @author Max Kugland
	 */
	public interface IAuthenticator extends IDistributor {
		/**
		 * Performs the authentication, for instance by querying a server. 
		 * Upon completion notifies it's listeners by distributing an 
		 * <code>AuthenticationEvent</code> about success or failure.
		 * 
		 * @@param data authentication data
		 * 
		 * @see org.splink.deepsplink.authentication.IAuthenticationRequest
		 */
		function login(data : *) : void;
		
		/**
		 * Logs out
		 */
		function logout() : void;

		/**
		 * Returns whether the last <code>IAuthenticationRequest</code> succeeded.
		 * 
		 * @return whether authentication succeeded
		 */
		function isAuthenticated() : Boolean;
	}
}
